home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / IZMB5-R.ZIP / IZM.DOC < prev    next >
Text File  |  1994-08-29  |  35KB  |  677 lines

  1.                   IceZmodem File Transfer Protocol Documentation
  2.  
  3.                                  By Alan Caruana
  4.  
  5.                        Copyright (C) 1994 IceSoft Software
  6.                                All Rights Reserved
  7.  
  8.                          Documentation for Version Beta5
  9.                                    PLEASE NOTE
  10.              Version Beta5 is a beta test copy and may contain bugs
  11.                     Please report ALL bugs to IceSoft Software
  12.  
  13.      Mail:  IceSoft Software       E-Mail: IceNET......: 3@1 or 3@2
  14.             215 Labelle Ave.               WWIV/WW4net.: 3@12180
  15.             Blasdell, NY 14219             Internet....: Icefreezr@delphi.com
  16.  
  17.                   IceSoft Software Support BBS: (716) 823-0424
  18.  
  19. ----------------------------< Table of Contents >-----------------------------
  20.  
  21.  Introduction...:  1. Shareware Notice/License/Distribution
  22.                    2. Disclaimer
  23.                       Description
  24.                    3. What is included
  25.                       Getting Started
  26.  IceZmodem Usage:  4. The IceZmodem Command Line
  27.                    6. Hardware Requirements
  28.                       The IZMSETUP Program
  29.                    7. IceZmodem Functions
  30.  You Should Know: 10. TurboTrans
  31.                       Handshaking
  32.                       The 16550 UART
  33.                       Acknowledgements
  34.  Appendixes....:  11. Appendix A: Freeing Your Memory
  35.                   12. Appendix B: Error Messages
  36.                   13. Appendix C: IceZmodem Command Line Examples
  37.                       Appendix D: Performance
  38.                   14. Appendix E: Revision History
  39.  
  40. --- PAGE 1 -----------------< Shareware Notice >------------------------------
  41.  
  42.  IceZmodem is distributed as an unregistered shareware product. This means
  43.  that an unregistered copy of IceZmodem may be freely distributed to any
  44.  individuals, businesses or organizations for evaluation purposes to decide
  45.  if the product is worth purchasing. If you like IceZmodem and decide to use
  46.  it, you must register (purchase) it.
  47.  
  48.  Using this shareware system, you will be able to try out the software before
  49.  you make a commitment to purchase it. If you have paid any money for this
  50.  program, it has gone to the distributor of the program and not to IceSoft
  51.  Software.
  52.  
  53.  BENEFITS OF REGISTRATION (Purchase)
  54.  """""""""""""""""""""""""""""""""""
  55.  Registration costs only $25 and will remove all annoying screens and sounds
  56.  and will enable enhanced features such as extended system information and
  57.  other future features. You also get telephone technical support. The best
  58.  part is, $25 will register this and ALL future versions of IceZmodem. You
  59.  will NEVER have to pay for an upgrade! To register, print the file
  60.  REGISTER.FRM or send a check or money order of $25 to:
  61.  
  62.                                 IceSoft Software
  63.                                 215 Labelle Ave.
  64.                                 Blasdell, NY 14219
  65.  
  66. ---------------------------------< License >----------------------------------
  67.  
  68.  IceZmodem, although it is on this computer, is not the property of the owner
  69.  of the computer. It is the property of IceSoft Software. It may be freely
  70.  distributed as long as all files are intact in the original ZIP package.
  71.  This distribution is for evaluation purposes only. Once it is established
  72.  that the operator of the computer is going to use IceZmodem continuously,
  73.  it must be registered. This applies to home, school, business or government
  74.  use.
  75.  
  76.  An UNREGISTERED VERSION (as freely distributed) may be shared freely.
  77.  
  78.  A REGISTERED VERSION of IceZmodem may NOT be distributed. A registered
  79.  version is for use on only ONE computer and may not be shared freely.
  80.  
  81.  If this program is to be used on more than one computer (such as in a
  82.  school or business) then the copies should be purchased in volume or a
  83.  site license should be obtained. Please contact IceSoft Software for more
  84.  information on volume discounts and site licenses.
  85.  
  86. -------------------------------< Distribution >-------------------------------
  87.  
  88.  The unregistered version of IceZmodem may be freely distributed unmodified
  89.  in its original ZIP package. You may charge a fee of no more than $5 for
  90.  distribution costs of IceZmodem. IceZmodem may not be bundled with any
  91.  hardware or software unless written permission is obtained from IceSoft
  92.  Software. IceZmodem program code and IceZmodem setup program may not be
  93.  edited, modified, disassembled or reverse-engineered by any means
  94.  whatsoever. IceZmodem documentation may not be modified, reproduced, edited
  95.  or translated by any means whatsoever.
  96.  
  97. --- PAGE 2 --------------------< Disclaimer >--------------------------------
  98.  
  99.  IceSoft Software is not responsible for any damages to your computer as a
  100.  result of using (or inability to use) IceZmodem. This includes loss of data,
  101.  files, and disk drives. This also includes loss of profit, savings and other
  102.  various damages aroused by the use of IceZmodem.
  103.  
  104.  IceZmodem is thoroughly tested on a variety of computer platforms before
  105.  beta or initial release to perform as stated in the documentation. However,
  106.  no warranty or guarantee may be stated due to the varying hardware systems
  107.  the software will run on.
  108.  
  109. -------------------------------< Description >--------------------------------
  110.  
  111.  IceZmodem Protocol Engine Description:
  112.  -------------------------------------
  113.  
  114.   IceZmodem is a Zmodem protocol with all of the standard features such as
  115.   variable block size, crash recovery, batch downloads and almost 100%
  116.   compatibility with other Zmodem protocols.
  117.  
  118.   IceZmodem offers a few options to speed up transfer performance when it is
  119.   connected to another computer running IceZmodem. These include:
  120.  
  121.    - Block size up to 2048 bytes (compared to Zmodem's 1024 byte block size)
  122.    - TurboTrans (which reduces the overhead encountered with Zmodem)
  123.  
  124.  IceZmodem Protocol Extra Features:
  125.  ---------------------------------
  126.  
  127.   When IceZmodem is connected to a standard Zmodem protocol:
  128.  
  129.    - You get one the most comprehensive status displays ever
  130.    - You can shell out to DOS to run any standard DOS commands or programs
  131.      (Transfer temporarily stops execution when programs are executed)
  132.    - You can activate the screen saver to blank the screen during transfer
  133.    - You can write or edit a text file while the transfer is in progress
  134.    - You can play a digital MOD music file while the transfer is in progress
  135.  
  136.   When IceZmodem is connected to another IceZmodem, you can use all of the
  137.   features listed above, plus:
  138.  
  139.    - You get information about the remote user including their name,
  140.      protocol, version, and their location within the IceZmodem protocol.
  141.    - You can chat with the remote user
  142.    - You can get a page of system information about the local and remote
  143.      computers.
  144.  
  145. --- PAGE 3 ----------------< What is included >------------------------------
  146.  
  147.    IZM.DOC      - The IceZmodem documentation you are reading now
  148.    IZM.EXE      - The actual IceZmodem protocol
  149.    IZMSETUP.EXE - The setup program which reads/writes the configuration to
  150.                   IZM.EXE.
  151.    INSTALL.DOC  - A text file that explains how to set up IceZmodem with
  152.                   many popular BBS systems and terminal programs.
  153.    REGISTER.FRM - A text file that you can print out to simplify registration
  154.                   of IceZmodem
  155.    IZM-U.BAT,
  156.    IZM-D.BAT    - Batch files for uploading and downloading files using
  157.                   IceZmodem. These batch files will work with most terminal
  158.                   programs, however you may need to modify the batch file.
  159.                   (Refer to INSTALL.DOC for more information)
  160.  
  161. -----------------------------< Getting Started >------------------------------
  162.  
  163.  IceZmodem can easily be configured to work with any BBS or terminal program.
  164.  The command lines that are used to operate IceZmodem are similar to the
  165.  popular DSZ external protocol. INSTALL.DOC contains instructions on how to
  166.  set up IceZmodem with many popular BBS and terminal programs. Refer to this
  167.  file now if you do not know how to get started with your particular BBS or
  168.  Terminal program. Also, be sure to run IZMSETUP.EXE! (see page 6)
  169.  
  170. --- PAGE 4 -------------< The IceZmodem Command Line >------------------------
  171.  
  172.                IZM [OPTIONS] <File Transfer Type> <File/Pathname>
  173.  
  174.  OPTIONS    (See Appendix C for examples on using IceZmodem)
  175.  """""""
  176.    port - This tells IceZmodem what COM PORT you would like to communicate
  177.           with. It can be any value from 1 to 4.  You do not need to specify
  178.           the port if you have already set up your default port in IZMSETUP
  179.           and the default port is the one you would like to use. Specifying
  180.           this option will override your default port in IZMSETUP, but it
  181.           will NOT override your default address/IRQ nonstandard port in
  182.           IZMSETUP.
  183.  
  184.            * Do not use the PORT option combined with the adrirq option *
  185.  
  186.           Below are the standard addresses and IRQs that IceZmodem recognizes
  187.           when you specify the port command. If your address/IRQ is different
  188.           than these, you need to use the adrirq option or set up your
  189.           default address/IRQ in IZMSETUP.
  190.  
  191.                            PORT 1:  Address 3F8   Irq 4
  192.                            PORT 2:  Address 2F8   Irq 3
  193.                            PORT 3:  Address 3E8   Irq 4
  194.                            PORT 4:  Address 2E8   Irq 3
  195.  
  196.    **** EXAMPLE FOR PORT: IZM port 2
  197.  
  198.  adrirq -  This tells IceZmodem the ADDRESS and the IRQ of your NONSTANDARD
  199.            COM PORT if you have one. If upon examining the chart above, you
  200.            do not find your port address/IRQ, you use this command to specify
  201.            the address/IRQ of your port. It uses the syntax:
  202.  
  203.                             adrirq address,irq
  204.  
  205.            This option will override the address/IRQ you specify in IZMSETUP
  206.                   * DO NOT USE ADRIRQ COMBINED WITH THE PORT OPTION *
  207.  
  208.    **** EXAMPLE FOR ADRIRQ: IZM adrirq 3F8,4
  209.  
  210.  speed  - This tells IceZmodem the speed (bits per second) that the COM PORT
  211.           is operating at. If this option is not specified, IceZmodem will
  212.           assume that the COM PORT is already set at the proper speed (which
  213.           it always should be before IceZmodem is executed) and should work
  214.           properly.
  215.  
  216.    **** EXAMPLE FOR SPEED: IZM port 2 speed 2400
  217.  
  218. --- PAGE 5 ------------------------------------------------------------------
  219.  
  220.    flow - After the word flow, you may use SLOW or HARD. Specifying SLOW
  221.           will cause IceZmodem to stop the sender from sending data during
  222.           disk writes. This is good if the receiver is writing the file to
  223.           a floppy disk or a slow hard disk. Specifying HARD will turn the
  224.           hardware handshaking on. This means if the sender is sending data
  225.           too fast and the receiver can't keep up, the receiver will tell the
  226.           sender to stop sending data until the receiver catches up. ALL high
  227.           speed modems MUST use flow hard.  These options override the
  228.           defaults that you specify in IZMSETUP.
  229.  
  230.           To make this plain and simple, if the receiver is writing to a slow
  231.           hard disk or floppy disk, you MUST use flow slow. If you are using
  232.           greater than 2400 bps, you MUST use flow hard.
  233.  
  234.           You may combine both flow slow and flow hard. See below:
  235.  
  236.      **** EXAMPLE FOR FLOW: IZM port 2 speed 2400 flow slow
  237.      **** EXAMPLE FOR FLOW: IZM speed 19200 flow hard
  238.      **** EXAMPLE FOR FLOW: IZM speed 38400 flow slow flow hard
  239.  
  240.    page - Use either PAGE ON or PAGE OFF to allow the remote to page you with
  241.           a loud beep or not. This will override your default selection in
  242.           IZMSETUP. If PAGE OFF is specified, the screen will flash on and
  243.           off instead of making an audible noise.
  244.  
  245.  File Transfer Type
  246.  """"""""""""""""""
  247.       RZ - Use this to receive data. If you do not specify anything after the
  248.           RZ, all files received will go into the current directory. After
  249.           the RZ you may specify a pathname and/or a filename. If a pathname
  250.           is specified, all files will go into that directory. If a filename
  251.           is specified, all received files will be renamed to that filename.
  252.           If a pathname AND filename is specified, all files will go into
  253.           that path and be renamed to the filename specified.
  254.  
  255.      SZ - This is the command to send data. This command must always be
  256.           followed by either:
  257.  
  258.                   A filename: SZ program.zip
  259.                   A pathname: SZ c:\bbs\dloads\sysop\program.zip
  260.                   Many Names: SZ program.zip c:\bbs\log.txt a:\program.exe
  261.                   Wildcards : SZ *.zip
  262.                   File Lists: SZ @file.lst
  263.  
  264.           OR a combination of ANY of the above things. The File List at the
  265.           end is an @ sign followed by a filename. In this file is a list of
  266.           path/filenames to send - one on each line of the file.
  267.  
  268.               For example, if the file LIST.TXT contained the following:
  269.                               \PROGRAMS\QUADL10.ZIP
  270.                               \BBS\DLOADS\SYSOP\MAIL.ZIP
  271.                               IZM110.ZIP
  272.                 ...You could send all 3 of those files with the line:
  273.                          IZM port 1 speed 2400 sz @list.txt
  274.  
  275.  Environment Variables
  276.  """""""""""""""""""""
  277.    If you set the environment variable DSZLOG equal to a filename, IceZmodem
  278.    will create a DSZ-compatible log for programs which require it to run.
  279.                   Example: SET DSZLOG=C:\BBS\DSZLOG.TXT
  280. --- PAGE 6 ----------------< Hardware Requirements >-------------------------
  281.  
  282.    Processor: 8086 or better. You will need at least an 80286 to use the
  283.               Digital MOD Music.
  284.  
  285.    DOS......: Version 3.0 or better. Any earlier versions will not work.
  286.               IceZmodem has not been tested with Windows or OS/2 and will not
  287.               work properly running under either platform.
  288.  
  289.    Memory...: At least 200k to transfer files. To play music, edit text files
  290.               and shell to dos, you must have from 200k-300k. This amount of
  291.               memory must be present on top of all the other memory taken by
  292.               terminal programs or BBS systems. (See Appendix A for
  293.               information on gaining more memory)
  294.  
  295.    Display..: Any display will work, but a color monitor is highly
  296.               recommended.
  297.  
  298.    Optional.: Sound Blaster, Disney Sound Source, or a parallel port D/A
  299.               converter for best sounding Digital Music.
  300.  
  301. ----------------------------< The IZMSETUP Program >--------------------------
  302.  
  303.  The IZMSETUP program included with the IceZmodem package lets you set up
  304.  many of the default options in IceZmodem and sets several options which are
  305.  not adjustable anywhere else in the program. I recommend that you run the
  306.  IZMSETUP.EXE program when you first install your IceZmodem and whenever you
  307.  upgrade to a newer version of IceZmodem. The configuration options are
  308.  stored within the IZM.EXE file itself - eliminating the need for more files
  309.  cluttering up your hard disk and causing more headaches. The only problem
  310.  with this is that you will need to run IZMSETUP whenever you receive an
  311.  IZM.EXE upgrade.
  312.  
  313.  When you first execute IZMSETUP, it will want to know where the IZM.EXE
  314.  file is located. If it is in the current directory, simply hit enter
  315.  otherwise tell it where it is. I am not going to document each option in
  316.  IZMSETUP because there is already documentation within the program. I
  317.  suggest that you go through each option and read what each option does and
  318.  choose wisely.
  319.  
  320. --- PAGE 7 -----------------< IceZmodem Functions >--------------------------
  321.  
  322.  Alt-A - Abort File Transfer
  323.  """""""""""""""""""""""""""
  324.     This will abort the file transfer and return an Exit Code of 1.
  325.  
  326.  F1 - Main Screen
  327.  """"""""""""""""
  328.     The main screen is the heart of IceZmodem. Here you will see how the
  329.     transfer is progressing by the numerous indicators and graphs.
  330.  
  331.   Download/Upload Status Window
  332.   """""""""""""""""""""""""""""
  333.     Block Size - This is the number of bytes that are transferred before a
  334.                  checksum takes place. The greater this number, the more
  335.                  efficient the transfer will be. IceZmodem uses 2048 byte
  336.                  blocks when connected to another IceZmodem. Standard Zmodem
  337.                  uses 1024 byte blocks.
  338.  
  339.     CPS - This stands for characters per second. Use this to determine
  340.           how efficient your transfer is going. (2400 bps = 240 cps)
  341.  
  342.     TurboTrans - This tells wether TurboTrans is in use or not. (See page 10)
  343.  
  344.       Messages - Information about the transfers progress and remote user
  345.                  status appears here.
  346.  
  347.     Completion - A graph and a percentage that tells how complete the file
  348.                  transfer is.
  349.  
  350.         Method - Usually CRC-32 or CRC-16. Tells what method of CRC is being
  351.                  used to check each block. The CRC-16 method is barely
  352.                  faster and offers half the protection against data errors.
  353.  
  354.     Efficiency - A percentage that will tell how efficient the transfer is
  355.                  going. 99% is the highest ever obtained with IceZmodem. If
  356.                  you are using locked com ports, this feature will read N/A.
  357.  
  358.     Time Total - IceZmodem analyzes the rate of characters comming in to the
  359.                  computer to predict the total time of the transfer, giving
  360.                  IceZmodem the most accurate total time prediction of any
  361.                  protocol.
  362.  
  363.     Batch Status Window - This window contains the same as above with the
  364.                           exception that the Batch is the information on
  365.                           all the files you are transferring if you are
  366.                           transferring multiple files.
  367.  
  368.       User Status Window
  369.       """"""""""""""""""
  370.            User - The name of the person who is operating the IceZmodem
  371.            Regs - Their registration name (if registered)
  372.            Vers - The version of Zmodem or IceZmodem being used
  373.  
  374.  F2 - Chat
  375.  """""""""
  376.      You may chat with the remote user on this screen. If they are not in
  377.      chat, hit F10 to page them. When somebody is paged in IceZmodem, either
  378.      a beeping noise will come out their speaker or (if the page is turned
  379.      off) the screen will flash. Once both people are in chat, just type a
  380.      sentence and hit enter. The message will appear in the upper window.
  381.  
  382. --- PAGE 8 ------------------------------------------------------------------
  383.  
  384.  F3 - DOS Shell
  385.  """"""""""""""
  386.      Using DOS Shell, you may execute any DOS commands or small programs
  387.      without greatly disturbing the transfer. Whenever you execute a
  388.      command or program in the DOS Shell, the file transfer temporarily
  389.      stops and then resumes when the prompt reappears. Knowing this,
  390.      you can execute small commands like DIR, RENAME, DEL, COPY, etc. and
  391.      the transfer wouldn't be harmed at all. You can load small utility
  392.      programs as well providing you dont remain in them for too long.
  393.      I wouldn't recommend staying in any executable file for more than
  394.      15-25 seconds. Especially if you are paying for long distance charges.
  395.      IceZmodem DOS Shell does not multitask. You cannot load up your favorite
  396.      text editor and expect the transfer to continue. There will be a certain
  397.      point where the buffer can no longer hold the incomming data and you
  398.      will loose data. This wont affect the file you are transfering.
  399.  
  400.  F4 - Screen Saver
  401.  """""""""""""""""
  402.      This will print the percentage complete in large numbers on a black
  403.      screen. To exit it, hit F1-F7 or any other key.
  404.  
  405.  F5 - Text Editor
  406.  """"""""""""""""
  407.      This is a simple text editor that I threw in at the last minute to see
  408.      if it could be done. There are some bugs in the text editor and I am
  409.      going to completely re-write the text editor in a future version.
  410.      Select a file to load. If you wish to create a new file, hit T and then
  411.      type in a filename. If you get an error message, refer to Appendix B.
  412.      The text editor can currently only load files 64k or less. The file must
  413.      not contain more than 78 characters per line. When you are done editing
  414.      the file, hit F9 to save it. If you dont want to save it, hit F8 to
  415.      unload the text file. You must either save or unload the text file
  416.      before IceZmodem will exit when the transfer is complete.
  417.  
  418.  F6 - Module Player
  419.  """"""""""""""""""
  420.      The Module Player will play Amiga Digital MOD music files. These should
  421.      be available on one of your local BBSs or any information service. They
  422.      are quite popular on many platforms these days, especially on the PC.
  423.      You may play the files using a PC Speaker, a D/A converter, a Sound
  424.      Blaster, or a Disney Sound Source. The PC Speaker provides very poor
  425.      sound reproduction and some sort of additional hardware is required to
  426.      hear true high fidelity sound. Assuming you have enough memory and you
  427.      have correctly configured your sound device and sampling rate in
  428.      IZMSETUP, you will now be able to select a file to play. If you get an
  429.      error message, refer to Appendix B. You may adjust the MOD volume, turn
  430.      channels 1,2,3,4 on and off and skip forward/backward in the song while
  431.      it is playing. You can go to any of the other functions in IceZmodem
  432.      and the MOD will continue playing (the sound will stop during DOS Shell)
  433.      including System Info, text editor and Chat. The MOD Player may not work
  434.      properly with LANtastic software or other Local Area Network Operating
  435.      Systems.
  436.  
  437.  F7 - System Information
  438.  """""""""""""""""""""""
  439.      This will present a page of system information about the local and
  440.      remote computers. Find out what kind of computer that guy REALLY is
  441.      using. Great for online technical support. Registered users can also
  442.      view the remote device drivers, TSRs, and open file handles. Future
  443.      versions will be expanded in this area even further.
  444. --- PAGE 9 ------------------------------------------------------------------
  445.  
  446.  F8 - Games
  447.  """"""""""
  448.      Just for fun, this will give you something to do during the transfer!
  449.      Willy Speedboat is a simple game where you use the left and right arrow
  450.      keys to avoid the bouys and other obstacles comming at you as you speed
  451.      down the river. There are four waves, if you complete the first group of
  452.      four waves you will go back to wave 1, although the game will be faster
  453.      this time! Good luck. WARNING: Excessive playing of this game will make
  454.      the room look like it is elevating when playing is discontinued!
  455.  
  456.  F9 - User Screen
  457.  """"""""""""""""
  458.      If you are using a display other than MDA, you will be able to use this
  459.      feature. This feature is primarily of intrest to sysops of BBS systems
  460.      to let them view the DOS screen that was displayed prior to IceZmodem
  461.      being loaded. Most BBS systems print what user is on the BBS and other
  462.      information on this screen. By pressing F9, the sysop can view this
  463.      information. Press F1-F8 to exit this screen when you are done viewing.
  464.  
  465.  
  466. --- PAGE 10 -------------------< TurboTrans >--------------------------------
  467.  
  468.   TurboTrans is a Zmodem speed booster which will enhance the efficiency of
  469.   your file transfer from 2 to 4 percent over standard Zmodem. It does this
  470.   by eliminating a 'feature' built into the original Zmodem standard. This
  471.   feature will not allow certain characters to flow through to avoid problems
  472.   with packet switching networks. These illegal characters must be sent as
  473.   TWO legal characters. This adds a decent amount of overhead to the file
  474.   transfer. When two IceZmodems are connected together they will usually be
  475.   connected by a direct modem connection, not a packet switching network.
  476.   Knowing this, IceZmodem will allow all but 2 characters to be sent through
  477.   as one character.
  478.  
  479. -------------------------------< Handshaking >--------------------------------
  480.  
  481.   There are thousands of different types of PCs out there, and along with
  482.   that, there are thousands of different speeds of PCs. Speed is dependant
  483.   on not only the processor and computer architecture, but also the software
  484.   that is running. For example, a memory manager slows down the speed of your
  485.   PC by a noticeable factor. Because modems allow us to hook faster PCs up
  486.   to slower ones, we need some way to let the slower PCs tell the faster
  487.   ones that they are sending data too fast for them to handle. That is
  488.   basically what Handshaking is. If the receiver cannot receive data as
  489.   fast as the sender is sending it, it has to tell the receiver to stop.
  490.   Handshaking is needed on ALL modems that run faster than 2400 bps. If
  491.   you use 2400 bps, you don't need to read this (now). If you are using
  492.   9600 bps or faster, you MUST understand handshaking. There are two
  493.   types of handshaking - hardware and software. All modems can use
  494.   software handshaking, but IceZmodem doesn't because it is inefficient
  495.   and adds overhead to the transfer, so lets ignore that for right now.
  496.   Hardware Handshaking. Most high speed modems transmit the CTS/RTS
  497.   (clear to send/request to send) signal on the phone line along with the
  498.   data that is being transmitted/received.  IceZmodem can manipulate this
  499.   signal to tell the sender to stop sending data when the receiver cannot
  500.   keep up. When the receiver catches up, it will resume the data
  501.   transmission. So, if you are using a high speed modem, BE SURE to set
  502.   HARDWARE HANDSHAKING to on - otherwise you will get a lot of errors
  503.   in the data transmission.
  504.  
  505. -----------------------------< The 16550 UART >-------------------------------
  506.  
  507.   If you are going to use over 9600 bps, I recommend you use a 16550 UART
  508.   chip. This will eliminate a lot of errors and problems you may have down
  509.   the road. You will be able to use over 9600 bps without a 16550, but
  510.   in practice, it is not a good idea - especially on slower computers.
  511.  
  512. -----------------------------< Acknowledgements >-----------------------------
  513.  
  514.  IceZmodem as it is today would not have been possible without the code that
  515.  has been written by 1) the person who wrote the Source Code for Pascal
  516.  Zmodem. There was no author listed in the public domain code. 2) Mark J. Cox
  517.  who wrote the module playing routines. 3) Chuck Forsberg who developed the
  518.  original Zmodem protocol which is pretty much the standard protocol for
  519.  file transfers now.
  520.  
  521.  I would like to thank all Beta testers, including Jim Nunn and Mark
  522.  Niedziela. And for support from God, Mom, and all IceZmodem users who
  523.  support this product.
  524.  
  525. --- PAGE 11 ----------< Appendix A: Freeing your Memory >--------------------
  526.  
  527.     IceZmodem is by no means a memory hog - however, when you load up a 200k
  528.     MOD file and a 50k text file and expect to shell to DOS you better have
  529.     a sufficient amount of memory available! If you dont have at least 400k
  530.     of free memory when you start up IceZmodem, your terminal program or BBS
  531.     program is chewing up all your memory. To get around this, set your
  532.     terminal program or BBS program to 'Maximum DOS Shell' or 'Shrink BBS' or
  533.     'Swap to Disk/EMS' or something to that effect. If your Terminal Program
  534.     or BBS doesn't support a shrink feature, tell the author to include one.
  535.     Most BBS and terminal programs have one nowadays anyway.
  536.  
  537. --- PAGE 12 -----------< Appendix B: Error Messages >------------------------
  538.  
  539. Error 45    This error means you are trying to tell IceZmodem to use both a
  540. """"""""    standard and a nonstandard COM port. You are probably using the
  541. PORT option on the command line when you already have an IRQ and ADDRESS set
  542. up in IZMSETUP. To get around this, set up a standard port in IZMSETUP and
  543. use the IRQADDR option on the command line. Another cause of this problem
  544. is trying to use the PORT and IRQADDR options at the same time.
  545.  
  546. Cannot load file. The file size is greater than 64k!
  547. """"""""""""""""""""""""""""""""""""""""""""""""""""
  548. The text editor is currently limited to editing files 64k or less. This will
  549. be corrected in a future version of IceZmodem.
  550.  
  551. Cannot load file. Line length is greater than 78 characters!
  552. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  553. The text editor is currently limited to editing files with a line length of
  554. 78 characters or less. This will be corrected in a future version of
  555. IceZmodem.
  556.  
  557. You have reached the maximum text file size. No more data may be added!
  558. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  559. You are attempting to add more than 64k of data to a large text file.
  560.  
  561. Not a valid ASCII text file!
  562. """"""""""""""""""""""""""""
  563. The text file cannot be parsed as a standard text file would. Either it is
  564. too intricate or it is not a text file.
  565.  
  566. Cannot LOAD or CREATE the filename you have specified!
  567. """"""""""""""""""""""""""""""""""""""""""""""""""""""
  568. An invalid filename has been specified. You may have accidentally typed in
  569. a pathname instead of a filename.
  570.  
  571. Not enough memory to load file
  572. """"""""""""""""""""""""""""""
  573. You must free up some memory by closing an open text file or turn off a MOD
  574. file. If nothing is open, then refer to Appendix A - suggestions for gaining
  575. more free memory.
  576.  
  577. Not enough memory to shell out to DOS!
  578. """"""""""""""""""""""""""""""""""""""
  579. You must free up some memory by closing an open text file or turn off a MOD
  580. file. If nothing is open, then refer to Appendix A - suggestions for gaining
  581. more free memory.
  582.  
  583. Not a 31 instrument MOD file!
  584. """""""""""""""""""""""""""""
  585. The MOD file that you are trying to load either 1) doesn't exist, 2) is not
  586. a MOD music file, or more commonly 3) Is an older 15 instrument MOD. If you
  587. run across a 15 instrument MOD, you will need to convert it to a newer 31
  588. instrument MOD before it can be played with IceZmodem. This can be done very
  589. easily with the program MODEDIT by Norman Lin. Simply load the MOD into this
  590. program (as if you were going to modify it) and then save it. The resulting
  591. save will be a 31 channel version of your older 15 channel MOD.
  592.  
  593. Runtime Error 005
  594. """""""""""""""""
  595. IZM.EXE cannot be modified by itself or IZMSETUP.EXE. You probably have the
  596. file attributes set to read-only or a network is not allowing write access.
  597.  
  598. Disk Read Error
  599. """""""""""""""
  600. Either there is something wrong with your disk drive or you do not have
  601. enough FILES specfied in your CONFIG.SYS. Add the line FILES=25 to correct.
  602.  
  603. --- PAGE 13 ---------< Appendix C: Command Line Examples >-------------------
  604.  
  605.  
  606. IZM RZ  - Will open the COM port specified in IZMSETUP at the baud rate that
  607.           the port is currently at. It will then receive files and put them
  608.           in the current directory.
  609.  
  610. IZM port 1 speed 2400 RZ c:\downloads - Will open COM1 at 2400 baud and
  611.                                         receive files into the directory
  612.                                         C:\DOWNLOADS.
  613.  
  614. IZM port 2 SZ F.TXT F2.EXE C.COM - Opens COM2 at the current baud rate and
  615.                                    sends F.TXT, F2.EXE, and C.COM.
  616.  
  617. IZM SZ @FILE.LST - Opens the COM port specified in IZMSETUP at the current
  618.                    baud rate. It then opens the file called FILE.LST and
  619.                    reads the path/filenames stored within and proceeds to
  620.                    send all files.
  621.  
  622. IZM port 3 speed 9600 SZ *.EXE - Opens COM3 at 9600 baud and transmits all
  623.                                  the files ending with EXE.
  624.  
  625. IZM adrirq 3e8,2 RZ - Opens a nonstandard port located at address 3E8(hex)
  626.                       using IRQ 2. It then receives files into the current
  627.                       directory.
  628.  
  629. IZM port 2 speed 57600 flow hard SZ C:\UPLOADS\START???.EXE - Opens COM2 at
  630.             57600 baud and turns hardware handshaking on. It will then send
  631.             all EXE files in the directory C:\UPLOADS that begin with
  632.             START.
  633.  
  634. --------------------------< Appendix D: Performance >-------------------------
  635.  
  636.                        System A               System B
  637.                        """"""""               """"""""
  638.                        80386-33               80386-33
  639.                     2400 bps Zoom          2400 bps Anchor
  640.  
  641.               Download of CRMEARTH.MOD from system A to system B
  642.             No compression in DSZ, IZM, or modem hardware was used
  643.  
  644.                     DSZ-DSZ with MobyTurbo = 237 Average CPS
  645.              IceZmodem-IceZmodem with TurboTrans = 237 Average CPS
  646.  
  647.      The IceZmodem-IceZmodem had peaks of up to 238 CPS (99% efficiency)
  648.  DSZ may have had these peaks as well but it doesn't report real-time CPS so
  649.                          it is not possible to tell.
  650.  
  651.     At 14400 bps, IceZmodem averages about 1670 CPS on 80386 class systems
  652.                   transferring a maximally compressed ZIP file.
  653.  
  654. --- PAGE 14 ----------< Appendix E: Revision History >-----------------------
  655.  
  656.  6/01/1994 Version Beta1 - First public Beta Test Release
  657.  
  658.  7/08/1994 Version Beta2 - Second Beta Test Release (LIMITED RELEASE)
  659.                 BUGS - Corrected too many bugs to mention here (over 30)
  660.             FEATURES - Added large number percent complete in Screen Saver
  661.                      - Added extended system information
  662.                      - Improved CPS
  663.                      - Added Turbo Options
  664.                      - Added Overwrite/Recover/Don't transfer options
  665.  
  666.  7/09/1994 Version Beta3 - Fixed major bug in version Beta2 (LIMITED RELEASE)
  667.  
  668.  7/15/1994 Version Beta4 - Fixed major bug in version Beta3 (Public Release)
  669.  
  670.  7/27/1994 Version Beta5 - Fixed minor bugs in version Beta4 (Public Release)
  671.                          - Fixed Crash Recovery
  672.                          - Fixed Chat Screen Flash
  673.                          - Efficiency "N/A" with locked baud rates
  674.                          - Added Speedboat Willy Game
  675.                          - Added adjustable block size
  676.         In future versions look for graphics/fonts and more games!
  677.